/*************************************************************************
 * @file: euleroperator.h
 * @date: 01/04/2012
 * TOPOL v1_0 - (c)copyright 2012 TEC/UFF
 *************************************************************************
 * This is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 ************************************************************************/

#ifndef _EULEROPERATOR
#define _EULEROPERATOR

// includes
//----------

// forward declarations
//----------------------


/*!
 * CLASS
 * EulerOperator
 * 
 * This class implements the Command Design Pattern in order to treat the
 * Euler Operators in the same way, as a command. This helps to manage the
 * undo and redo operations during the model construction.
 * 
 * @author Andre Pereira (andremaues@id.uff.br)
 * @version 1.0.0
 */
class EulerOperator
{

public:

  ////////////////////////////////////////////////
  ///  Constructor and Destructor Declaration  ///
  ////////////////////////////////////////////////

  /**
   * @brief Constructs an operator to manipulate the model
   */
	EulerOperator();

  ////////////////////////////////////
  ///  PUBLIC Methods Declaration  ///
  ////////////////////////////////////

  /**
   * @brief Executes an operation
   */
  virtual void execute()   = 0;

  /**
   * @brief Unexecutes an operation
   */
  virtual void unExecute() = 0;

};

#endif